Namespaces

Functions

null
active_theme()

Get the active theme code of the specified domain

at line 17
activity()

No description

at line 245
string
admin_url(string $uri = '', array $params = [])

Admin URL Create a local URL based on your admin path.

at line 78
array
array_add(array $array, string $key, mixed $value)

Add an element to an array using "dot" notation if it doesn't exist.

at line 491
array
array_collapse(array $array)

Collapse an array of arrays into a single array.

at line 504
array
array_divide(array $array)

Divide an array into two arrays. One with keys and the other with values.

at line 517
array
array_dot(array $array, string $prepend = '')

Flatten a multi-dimensional associative array with dots.

at line 531
array
array_except(array $array, array|string $keys)

Get all of the given array except for a specified array of keys.

at line 545
mixed
array_first(array $array, callable $callback = null, mixed $default = null)

Return the first element in an array passing a given truth test.

at line 560
array
array_flatten(array $array, int $depth = INF)

Flatten a multi-dimensional array into a single level.

at line 574
void
array_forget(array $array, array|string $keys)

Remove one or many array items from a given array using "dot" notation.

at line 588
mixed
array_get(ArrayAccess|array $array, string|int $key, mixed $default = null)

Get an item from an array using "dot" notation.

at line 603
bool
array_has(ArrayAccess|array $array, string|array $keys)

Check if an item or items exist in an array using "dot" notation.

at line 617
mixed
array_last(array $array, callable $callback = null, mixed $default = null)

Return the last element in an array passing a given truth test.

at line 632
array
array_only(array $array, array|string $keys)

Get a subset of the items from the given array.

at line 646
array
array_pluck(array $array, string|array $value, string|array|null $key = null)

Pluck an array of values from an array.

at line 661
array
array_prepend(array $array, mixed $value, mixed $key = null)

Push an item onto the beginning of an array.

at line 676
mixed
array_pull(array $array, string $key, mixed $default = null)

Get a value from the array, and remove it.

at line 691
mixed
array_random(array $array, int|null $num = null)

Get a random value from an array.

at line 705
array_replace_key($array, $oldKey, $newKey)

No description

at line 597
array
array_set(array $array, string $key, mixed $value)

Set an array item to a given value using "dot" notation.

at line 722
array
array_sort(array $array, callable|string|null $callback = null)

Sort the array by the given callback or attribute name.

at line 736
array
array_sort_recursive(array $array)

Recursively sort an array by keys and values.

at line 749
array_undot($dottedArray)

No description

at line 443
array
array_where(array $array, callable $callback)

Filter the array using the given callback.

at line 763
array
array_wrap(mixed $value)

If the given value is not an array, wrap it in one.

at line 776
string
assets_path(string $path = '')

Get the path to the assets folder.

at line 170
string
assets_url(string $uri = null, null $secure = null)

Assets URL Returns the full URL (including segments) of the assets directory

at line 32
string
camel_case(string $value)

Convert a value to camel case.

at line 789
Collection
collect(mixed $value = null)

Create a collection from the given value.

at line 461
combine($type, $assets = [])

No description

at line 130
string
component(string $component = '', array $params = [])

Check if Partial Area has rendered components

at line 70
bool
contains_substring(string $haystack, string|array $needles)

Determine if a given string contains a given substring.

at line 528
string
content(string $content = '', array $data = [])

Load a content template file

at line 26
controller()

Get the page controller

at line 10
string
convert_camelcase_to_underscore(string $string = '', bool $lowercase = false)

Convert CamelCase to underscore Camel_Case Converts a StringWithCamelCase into string_with_underscore. Strings can be passed via the first parameter either as a string or an array.

at line 491
int
convert_php_to_moment_js_format(string $format)

Convert PHP Date formats to Moment JS Date Formats

at line 164
string
convert_underscore_to_camelcase($string = '')

Current URL Converts a string_with_underscore into StringWithCamelCase. Strings can be passed via the first parameter either as a string or an array.

at line 513
countries($column = 'country_name', $key = 'country_id')

No description

at line 16
Currency|string
currency(float $amount = null, string $from = null, string $to = null, bool $format = true)

Convert given number.

at line 380
string
currency_format(float $amount = null, string $currency = null, bool $include_symbol = true)

Append or Prepend the default currency symbol to amounts

at line 400
array
currency_json(float $amount = null, string $currency = null)

Convert value to a currency array

at line 415
string
current_url()

Current URL Returns the full URL (including segments and query string) of the page where this function is placed

at line 16
string
day_elapsed(string $datetime, $full = true)

Get day elapsed Returns a day elapsed as today, yesterday or date d/M/y: Today or Yesterday or 12 Jan 15

at line 241
bool
ends_with(string $haystack, string|array $needles)

Determine if a given string ends with a given substring.

at line 803
string
extension_path(string $path = '')

Get the path to the extensions folder.

at line 156
flash(string|null $message = null, string $level = 'info')

Arrange for a flash message.

at line 430
string
form_button($value, array $options = [])

Form Button

at line 294
string
form_checkbox($name, int $value = 1, null $checked = null, array $options = [])

Checkbox Field

at line 224
string
form_close($extra = '')

Form Close Tag

at line 369
string
form_dropdown($name, array $list = [], mixed $selected = [], array $selectAttributes = [], array $optionAttributes = [])

Drop-down Menu

at line 185
string
form_error($field = null, $prefix = '', $suffix = '')

Form Error Returns the error for a specific form field. This is a helper for the form validation class.

at line 538
string
form_fieldset($legend_text = '', $options = [])

Fieldset Tag Used to produce

text. To close fieldset use form_fieldset_close()

at line 332
string
form_fieldset_close($extra = '')

Fieldset Close Tag

at line 353
string
form_hidden(string $name, mixed $value = null, array $options = [])

Hidden Input Field Generates hidden fields. You can pass a simple key/value string or an associative array with multiple values.

at line 70
string
form_input($name, $value = null, $options = [])

Text Input Field

at line 88
string
form_label($name, null $value = null, array $options = [], bool $escape_html = true)

Form Label Tag

at line 313
string
form_multiselect($name, array $list = [], array $selected = [], array $selectAttributes = [], array $optionAttributes = [])

Multi-select menu

at line 162
string
form_open($action = null, $attributes = [])

Form Declaration Creates the opening portion of the form.

at line 18
string
form_open_multipart($action = '', $attributes = [])

Form Declaration - Multipart type Creates the opening portion of the form, but with "multipart/form-data".

at line 48
string
form_password($name, array $options = [])

Password Field Identical to the input function but adds the "password" type

at line 106
string|string[]
form_prep(string|string[] $str)
deprecated

Form Prep Formats text so that it can be safely placed in a form field in the event it has HTML tags.

at line 386
string
form_radio($name, $value = null, $checked = null, $options = [])

Radio Button

at line 243
string
form_reset($value, array $options = [])

Reset Button

at line 277
string
form_select($name, array $list = [], mixed $selected = [], array $selectAttributes = [], array $optionAttributes = [])

Drop-down Menu

at line 205
string
form_submit($value = null, array $options = [])

Submit Button

at line 260
string
form_textarea($name, string $value = null, array $options = [])

Textarea field

at line 142
string
form_upload($name, array $options = [])

Upload Field Identical to the input function but adds the "file" type

at line 124
format_address($address, $useLineBreaks = true)

No description

at line 8
generate_extension_icon($icon)

No description

at line 567
mixed
get(null $name = null, null $default = null)

Identical function to input(), however restricted to $_GET values.

at line 311
string
get_class_id($name)

Generates a class ID from either an object or a string of the class name.

at line 349
string
get_favicon()

Get favicon html tag

at line 33
string
get_metas()

Get metas html tags

at line 10
string
get_script_tags()

Get multiple scripts html tags

at line 98
string
get_style_tags()

Get multiple stylesheet html tags

at line 59
string
get_title()

Get page title html tag

at line 81
string
has_component(string $component = '')

Check if a component is loaded

at line 55
string
has_form_error($field = null)

Form Error Returns the error for a specific form field. This is a helper for the form validation class.

at line 565
string
image_path(string $path = '')

Get the path to the assets image folder.

at line 77
string
image_url(string $uri = null, null $protocol = null)

Image Assets URL Returns the full URL (including segments) of the assets image directory

at line 61
string|array
input(string $name = null, string $default = null)

Returns an input parameter or the default value.

at line 267
bool
is_lang_key(string $line)

Determine if a given string matches a language key.

at line 548
bool
is_single_location()

Is Single Location Mode Test to see system config multi location mode is set to single.

at line 364
string
kebab_case(string $value)

Convert a string to kebab case.

at line 816
mixed
lang($key, array $replace = [], null $locale = null, bool $fallback = true)

Get the translation for the given key.

at line 335
void
log_message(string $level, string $message)

Error Logging Interface We use this as a simple mechanism to access the logging class and send messages to be logged.

at line 381
Carbon
make_carbon($value, bool $throwException = true)

Converts mixed inputs to a Carbon object.

at line 328
int
mdate(string $format = null, string $time = null)

Convert MySQL Style Datecodes This function is identical to PHPs date() function, except that it allows date codes to be formatted using the MySQL style, where each code letter is preceded with a percent sign: %Y %m %d etc... The benefit of doing dates this way is that you don't have to worry about escaping your text letters that match the date codes.

at line 129
array
name_to_array($string)

Converts a HTML named array string to a PHP array. Empty values are removed.

at line 457
string
name_to_id($string)

Converts a HTML array string to an identifier string.

at line 441
string
normalize_class_name($name)

Removes the starting slash from a class namespace \

at line 363
string
page()

Get the page content

at line 11
string
page_url(string $uri = null, array $params = [])

Page URL Returns the full URL (including segments) of the page where this function is placed

at line 27
mixed
params(null $key = null, null $default = null)

No description

at line 215
null
parent_theme(string $theme)

Get the parent theme code of the specified domain

at line 33
string
parse_date_format(string $format)

No description

at line 305
string
parse_values(array $columns, string $string)

Determine if a given string contains a given substring.

at line 235
string
partial(string $partial = '', array $data = [])

Load a partial template file

at line 41
mixed
post(null $name = null, null $default = null)

Identical function to input(), however restricted to $_POST values.

at line 289
string
referrer_url()

Referrer URL Returns the full URL (including segments) of the page where this function is placed

at line 125
string
restaurant_url(string $uri = null, array $params = [])

Restaurant URL Returns the full URL (including segments) of the local restaurant if any, else locations URL is returned

at line 61
string
root_url(string $uri = '', array $params = [])

Root URL Create a local URL based on your root path.

at line 142
string
set_checkbox($field, $value = '', $default = false)

Set Checkbox Let's you set the selected value of a checkbox via the value in the POST array.

at line 462
set_favicon(string $href = '')

Set favicon html tag

at line 45
set_meta(array $meta = [])

Set metas html tags

at line 22
string
set_radio(string $field, string $value = '', bool $default = false)

Set Radio Let's you set the selected value of a radio field via info in the POST array.

at line 500
set_script_tag(string $href = '', string $name = '')

Set single scripts html tags

at line 111
set_script_tags(array $tags = [])

Set multiple scripts html tags

at line 123
string
set_select($field, $value = '', $default = false)

Set Select Let's you set the selected value of a